home *** CD-ROM | disk | FTP | other *** search
/ PC World 2006 July & August / PCWorld_2006-07-08_cd.bin / komunikace / apache / apache_2[1].2.2-win32-x86-no_ssl.msi / Data1.cab / _4B358842F111934A0794D5EE0D24A287 < prev    next >
Extensible Markup Language  |  2006-01-20  |  38KB  |  632 lines
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
  4.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  5.               This file is generated from xml source: DO NOT EDIT
  6.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  7.       -->
  8. <title>mod_ldap - Apache HTTP Server</title>
  9. <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10. <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11. <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12. <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13. <body>
  14. <div id="page-header">
  15. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16. <p class="apache">Apache HTTP Server Version 2.2</p>
  17. <img alt="" src="../images/feather.gif" /></div>
  18. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  19. <div id="path">
  20. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.2</a> > <a href="./">Modules</a></div>
  21. <div id="page-content">
  22. <div id="preamble"><h1>Apache Module mod_ldap</h1>
  23. <div class="toplang">
  24. <p><span>Available Languages: </span><a href="../en/mod/mod_ldap.html" title="English"> en </a></p>
  25. </div>
  26. <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>LDAP connection pooling and result caching services for use
  27. by other LDAP modules</td></tr>
  28. <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  29. <tr><th><a href="module-dict.html#ModuleIdentifier">ModuleáIdentifier:</a></th><td>ldap_module</td></tr>
  30. <tr><th><a href="module-dict.html#SourceFile">SourceáFile:</a></th><td>util_ldap.c</td></tr>
  31. <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.0.41 and later</td></tr></table>
  32. <h3>Summary</h3>
  33.  
  34.     <p>This module was created to improve the performance of
  35.     websites relying on backend connections to LDAP servers. In
  36.     addition to the functions provided by the standard LDAP
  37.     libraries, this module adds an LDAP connection pool and an LDAP
  38.     shared memory cache.</p>
  39.  
  40.     <p>To enable this module, LDAP support must be compiled into
  41.     apr-util. This is achieved by adding the <code>--with-ldap</code>
  42.     flag to the <code class="program"><a href="../programs/configure.html">configure</a></code> script when building
  43.     Apache.</p>
  44.  
  45.     <p>SSL/TLS support is dependant on which LDAP toolkit has been
  46.     linked to <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a>. As of this writing, APR-util supports:
  47.     <a href="http://www.openldap.org/">OpenLDAP SDK</a> (2.x or later),
  48.     <a href="http://developer.novell.com/ndk/cldap.htm">Novell LDAP
  49.     SDK</a>, <a href="http://www.mozilla.org/directory/csdk.html">
  50.     Mozilla LDAP SDK</a>, native Solaris LDAP SDK (Mozilla based),
  51.     native Microsoft LDAP SDK, or the
  52.     <a href="http://www.iplanet.com/downloads/developer/">iPlanet
  53.     (Netscape)</a> SDK. See the <a href="http://apr.apache.org">APR</a>
  54.     website for details.</p>
  55.  
  56. </div>
  57. <div id="quickview"><h3 class="directives">Directives</h3>
  58. <ul id="toc">
  59. <li><img alt="" src="../images/down.gif" /> <a href="#ldapcacheentries">LDAPCacheEntries</a></li>
  60. <li><img alt="" src="../images/down.gif" /> <a href="#ldapcachettl">LDAPCacheTTL</a></li>
  61. <li><img alt="" src="../images/down.gif" /> <a href="#ldapconnectiontimeout">LDAPConnectionTimeout</a></li>
  62. <li><img alt="" src="../images/down.gif" /> <a href="#ldapopcacheentries">LDAPOpCacheEntries</a></li>
  63. <li><img alt="" src="../images/down.gif" /> <a href="#ldapopcachettl">LDAPOpCacheTTL</a></li>
  64. <li><img alt="" src="../images/down.gif" /> <a href="#ldapsharedcachefile">LDAPSharedCacheFile</a></li>
  65. <li><img alt="" src="../images/down.gif" /> <a href="#ldapsharedcachesize">LDAPSharedCacheSize</a></li>
  66. <li><img alt="" src="../images/down.gif" /> <a href="#ldaptrustedclientcert">LDAPTrustedClientCert</a></li>
  67. <li><img alt="" src="../images/down.gif" /> <a href="#ldaptrustedglobalcert">LDAPTrustedGlobalCert</a></li>
  68. <li><img alt="" src="../images/down.gif" /> <a href="#ldaptrustedmode">LDAPTrustedMode</a></li>
  69. <li><img alt="" src="../images/down.gif" /> <a href="#ldapverifyservercert">LDAPVerifyServerCert</a></li>
  70. </ul>
  71. <h3>Topics</h3>
  72. <ul id="topics">
  73. <li><img alt="" src="../images/down.gif" /> <a href="#exampleconfig">Example Configuration</a></li>
  74. <li><img alt="" src="../images/down.gif" /> <a href="#pool">LDAP Connection Pool</a></li>
  75. <li><img alt="" src="../images/down.gif" /> <a href="#cache">LDAP Cache</a></li>
  76. <li><img alt="" src="../images/down.gif" /> <a href="#usingssltls">Using SSL/TLS</a></li>
  77. <li><img alt="" src="../images/down.gif" /> <a href="#settingcerts">SSL/TLS Certificates</a></li>
  78. </ul></div>
  79. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  80. <div class="section">
  81. <h2><a name="exampleconfig" id="exampleconfig">Example Configuration</a></h2>
  82.     <p>The following is an example configuration that uses
  83.     <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> to increase the performance of HTTP Basic
  84.     authentication provided by <code class="module"><a href="../mod/mod_authnz_ldap.html">mod_authnz_ldap</a></code>.</p>
  85.  
  86.     <div class="example"><p><code>
  87.       # Enable the LDAP connection pool and shared<br />
  88.       # memory cache. Enable the LDAP cache status<br />
  89.       # handler. Requires that mod_ldap and mod_authnz_ldap<br />
  90.       # be loaded. Change the "yourdomain.example.com" to<br />
  91.       # match your domain.<br />
  92.       <br />
  93.       LDAPSharedCacheSize 200000<br />
  94.       LDAPCacheEntries 1024<br />
  95.       LDAPCacheTTL 600<br />
  96.       LDAPOpCacheEntries 1024<br />
  97.       LDAPOpCacheTTL 600<br />
  98.       <br />
  99.       <Location /ldap-status><br />
  100.       <span class="indent">
  101.         SetHandler ldap-status<br />
  102.         Order deny,allow<br />
  103.         Deny from all<br />
  104.         Allow from yourdomain.example.com<br />
  105.         AuthLDAPEnabled on<br />
  106.         AuthLDAPURL ldap://127.0.0.1/dc=example,dc=com?uid?one<br />
  107.         AuthLDAPAuthoritative on<br />
  108.         require valid-user<br />
  109.       </span>
  110.       </Location>
  111.     </code></p></div>
  112. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  113. <div class="section">
  114. <h2><a name="pool" id="pool">LDAP Connection Pool</a></h2>
  115.  
  116.     <p>LDAP connections are pooled from request to request. This
  117.     allows the LDAP server to remain connected and bound ready for
  118.     the next request, without the need to unbind/connect/rebind.
  119.     The performance advantages are similar to the effect of HTTP
  120.     keepalives.</p>
  121.  
  122.     <p>On a busy server it is possible that many requests will try
  123.     and access the same LDAP server connection simultaneously.
  124.     Where an LDAP connection is in use, Apache will create a new
  125.     connection alongside the original one. This ensures that the
  126.     connection pool does not become a bottleneck.</p>
  127.  
  128.     <p>There is no need to manually enable connection pooling in
  129.     the Apache configuration. Any module using this module for
  130.     access to LDAP services will share the connection pool.</p>
  131. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  132. <div class="section">
  133. <h2><a name="cache" id="cache">LDAP Cache</a></h2>
  134.  
  135.     <p>For improved performance, <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> uses an aggressive
  136.     caching strategy to minimize the number of times that the LDAP
  137.     server must be contacted. Caching can easily double or triple
  138.     the throughput of Apache when it is serving pages protected
  139.     with mod_authnz_ldap. In addition, the load on the LDAP server
  140.     will be significantly decreased.</p>
  141.  
  142.     <p><code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> supports two types of LDAP caching during
  143.     the search/bind phase with a <em>search/bind cache</em> and
  144.     during the compare phase with two <em>operation
  145.     caches</em>. Each LDAP URL that is used by the server has
  146.     its own set of these three caches.</p>
  147.  
  148.     <h3><a name="search-bind" id="search-bind">The Search/Bind Cache</a></h3>
  149.       <p>The process of doing a search and then a bind is the
  150.       most time-consuming aspect of LDAP operation, especially if
  151.       the directory is large. The search/bind cache is used to
  152.       cache all searches that resulted in successful binds.
  153.       Negative results (<em>i.e.</em>, unsuccessful searches, or searches
  154.       that did not result in a successful bind) are not cached.
  155.       The rationale behind this decision is that connections with
  156.       invalid credentials are only a tiny percentage of the total
  157.       number of connections, so by not caching invalid
  158.       credentials, the size of the cache is reduced.</p>
  159.  
  160.       <p><code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> stores the username, the DN
  161.       retrieved, the password used to bind, and the time of the bind
  162.       in the cache. Whenever a new connection is initiated with the
  163.       same username, <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> compares the password
  164.       of the new connection with the password in the cache. If the
  165.       passwords match, and if the cached entry is not too old,
  166.       <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> bypasses the search/bind phase.</p>
  167.  
  168.       <p>The search and bind cache is controlled with the <code class="directive"><a href="#ldapcacheentries">LDAPCacheEntries</a></code> and <code class="directive"><a href="#ldapcachettl">LDAPCacheTTL</a></code> directives.</p>
  169.     
  170.  
  171.     <h3><a name="opcaches" id="opcaches">Operation Caches</a></h3>
  172.       <p>During attribute and distinguished name comparison
  173.       functions, <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> uses two operation caches
  174.       to cache the compare operations. The first compare cache is
  175.       used to cache the results of compares done to test for LDAP
  176.       group membership. The second compare cache is used to cache
  177.       the results of comparisons done between distinguished
  178.       names.</p>
  179.  
  180.       <p>The behavior of both of these caches is controlled with
  181.       the <code class="directive"><a href="#ldapopcacheentries">LDAPOpCacheEntries</a></code>
  182.       and <code class="directive"><a href="#ldapopcachettl">LDAPOpCacheTTL</a></code>
  183.       directives.</p>
  184.     
  185.  
  186.     <h3><a name="monitoring" id="monitoring">Monitoring the Cache</a></h3>
  187.       <p><code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> has a content handler that allows
  188.       administrators to monitor the cache performance. The name of
  189.       the content handler is <code>ldap-status</code>, so the
  190.       following directives could be used to access the
  191.       <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> cache information:</p>
  192.  
  193.       <div class="example"><p><code>
  194.         <Location /server/cache-info><br />
  195.         <span class="indent">
  196.           SetHandler ldap-status<br />
  197.         </span>
  198.         </Location>
  199.       </code></p></div>
  200.  
  201.       <p>By fetching the URL <code>http://servername/cache-info</code>,
  202.       the administrator can get a status report of every cache that is used
  203.       by <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code> cache. Note that if Apache does not
  204.       support shared memory, then each <code class="program"><a href="../programs/httpd.html">httpd</a></code> instance has its
  205.       own cache, so reloading the URL will result in different
  206.       information each time, depending on which <code class="program"><a href="../programs/httpd.html">httpd</a></code>
  207.       instance processes the request.</p>
  208.     
  209. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  210. <div class="section">
  211. <h2><a name="usingssltls" id="usingssltls">Using SSL/TLS</a></h2>
  212.  
  213.     <p>The ability to create an SSL and TLS connections to an LDAP server 
  214.     is defined by the directives <code class="directive"><a href="#     ldaptrustedglobalcert">
  215.     LDAPTrustedGlobalCert</a></code>, <code class="directive"><a href="#     ldaptrustedclientcert">
  216.     LDAPTrustedClientCert</a></code> and <code class="directive"><a href="#     ldaptrustedmode">
  217.     LDAPTrustedMode</a></code>. These directives specify the CA and
  218.     optional client certificates to be used, as well as the type of
  219.     encryption to be used on the connection (none, SSL or TLS/STARTTLS).</p>
  220.  
  221.     <div class="example"><p><code>
  222.       # Establish an SSL LDAP connection on port 636. Requires that <br />
  223.       # mod_ldap and mod_authnz_ldap be loaded. Change the <br />
  224.       # "yourdomain.example.com" to match your domain.<br />
  225.       <br />
  226.       LDAPTrustedGlobalCert CA_DER /certs/certfile.der<br />
  227.       <br />
  228.       <Location /ldap-status><br />
  229.       <span class="indent">
  230.         SetHandler ldap-status<br />
  231.         Order deny,allow<br />
  232.         Deny from all<br />
  233.         Allow from yourdomain.example.com<br />
  234.         AuthLDAPEnabled on<br />
  235.         AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one<br />
  236.         AuthLDAPAuthoritative on<br />
  237.         require valid-user<br />
  238.       </span>
  239.       </Location>
  240.     </code></p></div>
  241.  
  242.     <div class="example"><p><code>
  243.       # Establish a TLS LDAP connection on port 389. Requires that <br />
  244.       # mod_ldap and mod_authnz_ldap be loaded. Change the <br />
  245.       # "yourdomain.example.com" to match your domain.<br />
  246.       <br />
  247.       LDAPTrustedGlobalCert CA_DER /certs/certfile.der<br />
  248.       <br />
  249.       <Location /ldap-status><br />
  250.       <span class="indent">
  251.         SetHandler ldap-status<br />
  252.         Order deny,allow<br />
  253.         Deny from all<br />
  254.         Allow from yourdomain.example.com<br />
  255.         AuthLDAPEnabled on<br />
  256.         AuthLDAPURL ldap://127.0.0.1/dc=example,dc=com?uid?one TLS<br />
  257.         AuthLDAPAuthoritative on<br />
  258.         require valid-user<br />
  259.       </span>
  260.       </Location>
  261.     </code></p></div>
  262.  
  263. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  264. <div class="section">
  265. <h2><a name="settingcerts" id="settingcerts">SSL/TLS Certificates</a></h2>
  266.  
  267.     <p>The different LDAP SDKs have widely different methods of setting
  268.     and handling both CA and client side certificates.</p>
  269.  
  270.     <p>If you intend to use SSL or TLS, read this section CAREFULLY so as to
  271.     understand the differences between configurations on the different LDAP
  272.     toolkits supported.</p>
  273.  
  274.     <h3><a name="settingcerts-netscape" id="settingcerts-netscape">Netscape/Mozilla/iPlanet SDK</a></h3>
  275.         <p>CA certificates are specified within a file called cert7.db.
  276.         The SDK will not talk to any LDAP server whose certificate was
  277.         not signed by a CA specified in this file. If
  278.         client certificates are required, an optional key3.db file may
  279.         be specified with an optional password. The secmod file can be
  280.         specified if required. These files are in the same format as
  281.         used by the Netscape Communicator or Mozilla web browsers. The easiest
  282.         way to obtain these files is to grab them from your browser
  283.         installation.</p>
  284.  
  285.         <p>Client certificates are specified per connection using the
  286.         LDAPTrustedClientCert directive by referring
  287.         to the certificate "nickname". An optional password may be
  288.         specified to unlock the certificate's private key.</p>
  289.  
  290.         <p>The SDK supports SSL only. An attempt to use STARTTLS will cause
  291.         an error when an attempt is made to contact the LDAP server at
  292.         runtime.</p>
  293.  
  294.         <div class="example"><p><code>
  295.             # Specify a Netscape CA certificate file<br />
  296.             LDAPTrustedGlobalCert CA_CERT7_DB /certs/cert7.db<br />
  297.             # Specify an optional key3.db file for client certificate support<br />
  298.             LDAPTrustedGlobalCert CERT_KEY3_DB /certs/key3.db<br />
  299.             # Specify the secmod file if required<br />
  300.             LDAPTrustedGlobalCert CA_SECMOD /certs/secmod<br />
  301.             <Location /ldap-status><br />
  302.             <span class="indent">
  303.                 SetHandler ldap-status<br />
  304.                 Order deny,allow<br />
  305.                 Deny from all<br />
  306.                 Allow from yourdomain.example.com<br />
  307.                 AuthLDAPEnabled on<br />
  308.                 LDAPTrustedClientCert CERT_NICKNAME <nickname> [password]<br />
  309.                 AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one<br />
  310.                 AuthLDAPAuthoritative on<br />
  311.                 require valid-user<br />
  312.             </span>
  313.             </Location>
  314.         </code></p></div>
  315.  
  316.     
  317.  
  318.     <h3><a name="settingcerts-novell" id="settingcerts-novell">Novell SDK</a></h3>
  319.  
  320.         <p>One or more CA certificates must be specified for the Novell
  321.         SDK to work correctly. These certificates can be specified as
  322.         binary DER or Base64 (PEM) encoded files.</p>
  323.  
  324.         <p>Note: Client certificates are specified globally rather than per
  325.         connection, and so must be specified with the LDAPTrustedGlobalCert
  326.         directive as below. Trying to set client certificates via the
  327.         LDAPTrustedClientCert directive will cause an error to be logged
  328.         when an attempt is made to connect to the LDAP server..</p>
  329.  
  330.         <p>The SDK supports both SSL and STARTTLS, set using the
  331.         LDAPTrustedMode parameter. If an ldaps:// URL is specified,
  332.         SSL mode is forced, override this directive.</p>
  333.  
  334.         <div class="example"><p><code>
  335.              # Specify two CA certificate files<br />
  336.              LDAPTrustedGlobalCert CA_DER /certs/cacert1.der<br />
  337.              LDAPTrustedGlobalCert CA_BASE64 /certs/cacert2.pem<br />
  338.              # Specify a client certificate file and key<br />
  339.              LDAPTrustedGlobalCert CERT_BASE64 /certs/cert1.pem<br />
  340.              LDAPTrustedGlobalCert KEY_BASE64 /certs/key1.pem [password]<br />
  341.              # Do not use this directive, as it will throw an error<br />
  342.              #LDAPTrustedClientCert CERT_BASE64 /certs/cert1.pem<br />
  343.         </code></p></div>
  344.  
  345.     
  346.  
  347.     <h3><a name="settingcerts-openldap" id="settingcerts-openldap">OpenLDAP SDK</a></h3>
  348.  
  349.         <p>One or more CA certificates must be specified for the OpenLDAP
  350.         SDK to work correctly. These certificates can be specified as
  351.         binary DER or Base64 (PEM) encoded files.</p>
  352.  
  353.         <p>Client certificates are specified per connection using the
  354.         LDAPTrustedClientCert directive.</p>
  355.  
  356.         <p>The documentation for the SDK claims to support both SSL and
  357.         STARTTLS, however STARTTLS does not seem to work on all versions
  358.         of the SDK. The SSL/TLS mode can be set using the
  359.         LDAPTrustedMode parameter. If an ldaps:// URL is specified,
  360.         SSL mode is forced. The OpenLDAP documentation notes that SSL
  361.         (ldaps://) support has been deprecated to be replaced with TLS,
  362.         although the SSL functionality still works.</p>
  363.  
  364.         <div class="example"><p><code>
  365.              # Specify two CA certificate files<br />
  366.              LDAPTrustedGlobalCert CA_DER /certs/cacert1.der<br />
  367.              LDAPTrustedGlobalCert CA_BASE64 /certs/cacert2.pem<br />
  368.             <Location /ldap-status><br />
  369.             <span class="indent">
  370.                 SetHandler ldap-status<br />
  371.                 Order deny,allow<br />
  372.                 Deny from all<br />
  373.                 Allow from yourdomain.example.com<br />
  374.                 AuthLDAPEnabled on<br />
  375.                 LDAPTrustedClientCert CERT_BASE64 /certs/cert1.pem<br />
  376.                 LDAPTrustedClientCert KEY_BASE64 /certs/key1.pem<br />
  377.                 AuthLDAPURL ldaps://127.0.0.1/dc=example,dc=com?uid?one<br />
  378.                 AuthLDAPAuthoritative on<br />
  379.                 require valid-user<br />
  380.             </span>
  381.             </Location>
  382.         </code></p></div>
  383.  
  384.     
  385.  
  386.     <h3><a name="settingcerts-solaris" id="settingcerts-solaris">Solaris SDK</a></h3>
  387.  
  388.         <p>SSL/TLS for the native Solaris LDAP libraries is not yet
  389.         supported. If required, install and use the OpenLDAP libraries
  390.         instead.</p>
  391.  
  392.     
  393.  
  394.     <h3><a name="settingcerts-microsoft" id="settingcerts-microsoft">Microsoft SDK</a></h3>
  395.  
  396.         <p>SSL/TLS certificate configuration for the native Microsoft
  397.         LDAP libraries is done inside the system registry, and no
  398.         configuration directives are required.</p>
  399.  
  400.         <p>Both SSL and TLS are supported by using the ldaps:// URL
  401.         format, or by using the LDAPTrustedMode directive accordingly.</p>
  402.  
  403.         <p>Note: The status of support for client certificates is not yet known
  404.         for this toolkit.</p>
  405.  
  406.     
  407.  
  408. </div>
  409. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  410. <div class="directive-section"><h2><a name="LDAPCacheEntries" id="LDAPCacheEntries">LDAPCacheEntries</a> <a name="ldapcacheentries" id="ldapcacheentries">Directive</a></h2>
  411. <table class="directive">
  412. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum number of entries in the primary LDAP cache</td></tr>
  413. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPCacheEntries <var>number</var></code></td></tr>
  414. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPCacheEntries 1024</code></td></tr>
  415. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  416. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  417. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
  418. </table>
  419.     <p>Specifies the maximum size of the primary LDAP cache. This
  420.     cache contains successful search/binds. Set it to 0 to turn off
  421.     search/bind caching. The default size is 1024 cached
  422.     searches.</p>
  423.  
  424. </div>
  425. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  426. <div class="directive-section"><h2><a name="LDAPCacheTTL" id="LDAPCacheTTL">LDAPCacheTTL</a> <a name="ldapcachettl" id="ldapcachettl">Directive</a></h2>
  427. <table class="directive">
  428. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Time that cached items remain valid</td></tr>
  429. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPCacheTTL <var>seconds</var></code></td></tr>
  430. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPCacheTTL 600</code></td></tr>
  431. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  432. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  433. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
  434. </table>
  435.     <p>Specifies the time (in seconds) that an item in the
  436.     search/bind cache remains valid. The default is 600 seconds (10
  437.     minutes).</p>
  438.  
  439. </div>
  440. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  441. <div class="directive-section"><h2><a name="LDAPConnectionTimeout" id="LDAPConnectionTimeout">LDAPConnectionTimeout</a> <a name="ldapconnectiontimeout" id="ldapconnectiontimeout">Directive</a></h2>
  442. <table class="directive">
  443. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specifies the socket connection timeout in seconds</td></tr>
  444. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPConnectionTimeout <var>seconds</var></code></td></tr>
  445. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  446. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  447. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
  448. </table>
  449.     <p>Specifies the timeout value (in seconds) in which the module will
  450.     attempt to connect to the LDAP server.  If a connection is not
  451.     successful with the timeout period, either an error will be 
  452.     returned or the module will attempt to connect to a secondary LDAP 
  453.     server if one is specified. The default is 10 seconds.</p>
  454.  
  455. </div>
  456. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  457. <div class="directive-section"><h2><a name="LDAPOpCacheEntries" id="LDAPOpCacheEntries">LDAPOpCacheEntries</a> <a name="ldapopcacheentries" id="ldapopcacheentries">Directive</a></h2>
  458. <table class="directive">
  459. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Number of entries used to cache LDAP compare 
  460. operations</td></tr>
  461. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPOpCacheEntries <var>number</var></code></td></tr>
  462. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPOpCacheEntries 1024</code></td></tr>
  463. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  464. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  465. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
  466. </table>
  467.     <p>This specifies the number of entries <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code>
  468.     will use to cache LDAP compare operations. The default is 1024
  469.     entries.  Setting it to 0 disables operation caching.</p>
  470.  
  471. </div>
  472. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  473. <div class="directive-section"><h2><a name="LDAPOpCacheTTL" id="LDAPOpCacheTTL">LDAPOpCacheTTL</a> <a name="ldapopcachettl" id="ldapopcachettl">Directive</a></h2>
  474. <table class="directive">
  475. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Time that entries in the operation cache remain
  476. valid</td></tr>
  477. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPOpCacheTTL <var>seconds</var></code></td></tr>
  478. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPOpCacheTTL 600</code></td></tr>
  479. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  480. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  481. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
  482. </table>
  483.     <p>Specifies the time (in seconds) that entries in the
  484.     operation cache remain valid. The default is 600 seconds.</p>
  485.  
  486. </div>
  487. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  488. <div class="directive-section"><h2><a name="LDAPSharedCacheFile" id="LDAPSharedCacheFile">LDAPSharedCacheFile</a> <a name="ldapsharedcachefile" id="ldapsharedcachefile">Directive</a></h2>
  489. <table class="directive">
  490. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the shared memory cache file</td></tr>
  491. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPSharedCacheFile <var>directory-path/filename</var></code></td></tr>
  492. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  493. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  494. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
  495. </table>
  496.     <p>Specifies the directory path and file name of the shared memory
  497.     cache file. If not set, anonymous shared memory will be used if the
  498.     platform supports it.</p>
  499.  
  500. </div>
  501. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  502. <div class="directive-section"><h2><a name="LDAPSharedCacheSize" id="LDAPSharedCacheSize">LDAPSharedCacheSize</a> <a name="ldapsharedcachesize" id="ldapsharedcachesize">Directive</a></h2>
  503. <table class="directive">
  504. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Size in bytes of the shared-memory cache</td></tr>
  505. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPSharedCacheSize <var>bytes</var></code></td></tr>
  506. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPSharedCacheSize 102400</code></td></tr>
  507. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  508. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  509. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
  510. </table>
  511.     <p>Specifies the number of bytes to allocate for the shared
  512.     memory cache. The default is 100kb. If set to 0, shared memory
  513.     caching will not be used.</p>
  514.  
  515. </div>
  516. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  517. <div class="directive-section"><h2><a name="LDAPTrustedClientCert" id="LDAPTrustedClientCert">LDAPTrustedClientCert</a> <a name="ldaptrustedclientcert" id="ldaptrustedclientcert">Directive</a></h2>
  518. <table class="directive">
  519. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the file containing or nickname referring to a per
  520. connection client certificate. Not all LDAP toolkits support per
  521. connection client certificates.</td></tr>
  522. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPTrustedClientCert <var>type</var> <var>directory-path/filename/nickname</var> <var>[password]</var></code></td></tr>
  523. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  524. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  525. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
  526. </table>
  527.     <p>It specifies the directory path, file name or nickname of a
  528.     per connection client certificate used when establishing an SSL
  529.     or TLS connection to an LDAP server. Different locations or
  530.     directories may have their own independant client certificate
  531.     settings. Some LDAP toolkits (notably Novell)
  532.     do not support per connection client certificates, and will throw an
  533.     error on LDAP server connection if you try to use this directive
  534.     (Use the LDAPTrustedGlobalCert directive instead for Novell client
  535.     certificates - See the SSL/TLS certificate guide above for details).
  536.     The type specifies the kind of certificate parameter being
  537.     set, depending on the LDAP toolkit being used. Supported types are:</p>
  538.     <ul>
  539.       <li>CERT_DER - binary DER encoded client certificate</li>
  540.       <li>CERT_BASE64 - PEM encoded client certificate</li>
  541.       <li>CERT_NICKNAME - Client certificate "nickname" (Netscape SDK)</li>
  542.       <li>KEY_DER - binary DER encoded private key</li>
  543.       <li>KEY_BASE64 - PEM encoded private key</li>
  544.     </ul>
  545.  
  546. </div>
  547. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  548. <div class="directive-section"><h2><a name="LDAPTrustedGlobalCert" id="LDAPTrustedGlobalCert">LDAPTrustedGlobalCert</a> <a name="ldaptrustedglobalcert" id="ldaptrustedglobalcert">Directive</a></h2>
  549. <table class="directive">
  550. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the file or database containing global trusted
  551. Certificate Authority or global client certificates</td></tr>
  552. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPTrustedGlobalCert <var>type</var> <var>directory-path/filename</var> <var>[password]</var></code></td></tr>
  553. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  554. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  555. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
  556. </table>
  557.     <p>It specifies the directory path and file name of the trusted CA
  558.     certificates and/or system wide client certificates <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code>
  559.     should use when establishing an SSL or TLS connection to an LDAP
  560.     server. Note that all certificate information specified using this directive
  561.     is applied globally to the entire server installation. Some LDAP toolkits
  562.     (notably Novell) require all client certificates to be set globally using
  563.     this directive. Most other toolkits require clients certificates to be set
  564.     per Directory or per Location using LDAPTrustedClientCert. If you get this
  565.     wrong, an error may be logged when an attempt is made to contact the LDAP
  566.     server, or the connection may silently fail (See the SSL/TLS certificate
  567.     guide above for details).
  568.     The type specifies the kind of certificate parameter being
  569.     set, depending on the LDAP toolkit being used. Supported types are:</p>
  570.     <ul>
  571.       <li>CA_DER - binary DER encoded CA certificate</li>
  572.       <li>CA_BASE64 - PEM encoded CA certificate</li>
  573.       <li>CA_CERT7_DB - Netscape cert7.db CA certificate database file</li>
  574.       <li>CA_SECMOD - Netscape secmod database file</li>
  575.       <li>CERT_DER - binary DER encoded client certificate</li>
  576.       <li>CERT_BASE64 - PEM encoded client certificate</li>
  577.       <li>CERT_KEY3_DB - Netscape key3.db client certificate database file</li>
  578.       <li>CERT_NICKNAME - Client certificate "nickname" (Netscape SDK)</li>
  579.       <li>CERT_PFX - PKCS#12 encoded client certificate (Novell SDK)</li>
  580.       <li>KEY_DER - binary DER encoded private key</li>
  581.       <li>KEY_BASE64 - PEM encoded private key</li>
  582.       <li>KEY_PFX - PKCS#12 encoded private key (Novell SDK)</li>
  583.     </ul>
  584.  
  585. </div>
  586. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  587. <div class="directive-section"><h2><a name="LDAPTrustedMode" id="LDAPTrustedMode">LDAPTrustedMode</a> <a name="ldaptrustedmode" id="ldaptrustedmode">Directive</a></h2>
  588. <table class="directive">
  589. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specifies the SSL/TLS mode to be used when connecting to an LDAP server.</td></tr>
  590. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPTrustedMode <var>type</var></code></td></tr>
  591. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  592. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  593. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
  594. </table>
  595.     <p>The following modes are supported:</p>
  596.     <ul>
  597.       <li>NONE - no encryption</li>
  598.       <li>SSL - ldaps:// encryption on default port 636</li>
  599.       <li>TLS - STARTTLS encryption on default port 389</li>
  600.     </ul>
  601.  
  602.     <p>Not all LDAP toolkits support all the above modes. An error message
  603.     will be logged at runtime if a mode is not supported, and the
  604.     connection to the LDAP server will fail.
  605.     </p>
  606.  
  607.     <p>If an ldaps:// URL is specified, the mode becomes SSL and the setting
  608.     of LDAPTrustedMode is ignored.</p>
  609.  
  610. </div>
  611. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  612. <div class="directive-section"><h2><a name="LDAPVerifyServerCert" id="LDAPVerifyServerCert">LDAPVerifyServerCert</a> <a name="ldapverifyservercert" id="ldapverifyservercert">Directive</a></h2>
  613. <table class="directive">
  614. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Force server certificate verification</td></tr>
  615. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LDAPVerifyServerCert <var>On|Off</var></code></td></tr>
  616. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LDAPVerifyServerCert On</code></td></tr>
  617. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
  618. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  619. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ldap</td></tr>
  620. </table>
  621.     <p>Specifies whether to force the verification of a 
  622.      server certificate when establishing an SSL connection to the 
  623.      LDAP server.</p>
  624.  
  625. </div>
  626. </div>
  627. <div class="bottomlang">
  628. <p><span>Available Languages: </span><a href="../en/mod/mod_ldap.html" title="English"> en </a></p>
  629. </div><div id="footer">
  630. <p class="apache">Copyright 1995-2006 The Apache Software Foundation or its licensors, as applicable.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
  631. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
  632. </body></html>